WriteMessage(LogMessageSeverity,LogWriteMode,String,String,IMessageSourceProvider,IPrincipal,Exception,String,String,String,Object[]) Method

In This Topic

Write a complete log message to the Gibraltar central log.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Sub WriteMessage( _
   ByVal severity As LogMessageSeverity, _
   ByVal writeMode As LogWriteMode, _
   ByVal logSystem As String, _
   ByVal categoryName As String, _
   ByVal sourceProvider As IMessageSourceProvider, _
   ByVal principal As IPrincipal, _
   ByVal exception As Exception, _
   ByVal detailsXml As String, _
   ByVal caption As String, _
   ByVal description As String, _
   ByVal ParamArray args() As Object _
)

public static void WriteMessage( 
   LogMessageSeverity severity,
   LogWriteMode writeMode,
   string logSystem,
   string categoryName,
   IMessageSourceProvider sourceProvider,
   IPrincipal principal,
   Exception exception,
   string detailsXml,
   string caption,
   string description,
   params object[] args
)

Parameters

severity: The severity enum value of the log message.
writeMode: A LogWriteMode enum value indicating whether to simply queue the log message and return quickly, or to wait for the log message to be committed to disk before returning.
logSystem: The name of the originating log system, such as "Trace", "Log4Net", or "Gibraltar".
categoryName: The logging category or application subsystem category that the log message is associated with, such as "Trace", "Console", "Exception", or the logger name in Log4Net.
sourceProvider: An IMessageSourceProvider object which supplies the source information about this log message.
principal: The effective user principal associated with the execution task which issued the log message.
exception: An Exception object attached to this log message, or null if none.
detailsXml: Optional. An XML document with extended details about the message. Can be null.
caption: A single line display caption.
description: Optional. A multi-line description to use which can be a format string for the arguments. Can be null.
args: Optional. A variable number of arguments to insert into the formatted description string.

Remarks

Used as an API entry point for interfaces for other logging systems to hand off log messages into Gibraltar. This method ONLY supports being invoked on the same thread which originated the log message.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Log Class
Log Members
Overload List

Send Feedback